home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / indicatorclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.5 KB  |  131 lines
  1. TABLE OF CONTENTS
  2.  
  3. indicatorclass/--background--
  4. indicatorclass/INDIC_FormatString
  5. indicatorclass/INDIC_Justification
  6. indicatorclass/INDIC_Level
  7. indicatorclass/INDIC_Max
  8. indicatorclass/INDIC_Min
  9.  
  10. indicatorclass/--background--
  11.  
  12.     NAME
  13.     Class:        indicatorclass
  14.     Superclass:    baseclass
  15.     Include File:    <libraries/bgui.h>
  16.  
  17.     FUNCTION
  18.     To  provide  a    textual level indicator for gadget objects which might
  19.     need this like the slider and progress classes. As this class may also
  20.     be  useful  in    conjunction with other third party classes it has been
  21.     made available.
  22.  
  23.     Objects of this class do not send out notification events.
  24.  
  25. indicatorclass/INDIC_FormatString
  26.  
  27.     NAME
  28.     INDIC_FormatString -- ( STRPTR )
  29.  
  30.     FUNCTION
  31.     Set  the  C-style  format  string  which is used to format the current
  32.     level before rendering.
  33.  
  34.     NOTE: Since  V38  of  the  library  it    is  possible  to  use locale's
  35.           FormatString()  formatting  codes.  Locale  specific  formatting
  36.           codes will only work when the locale.library is available.
  37.  
  38.     DEFAULT
  39.     "%ld".
  40.  
  41.     APPLICABILITY
  42.     (ISGU).
  43.  
  44.     NOTE
  45.     Setting the format string neither updates the minimum size nor redraws
  46.     the object. It is better to set it only when the window is closed.
  47.  
  48.     SEE ALSO
  49.     exec.library/RawDoFmt(), INDIC_Level
  50.  
  51. indicatorclass/INDIC_Justification
  52.  
  53.     NAME
  54.     INDIC_Justification -- ( ULONG )
  55.  
  56.     FUNCTION
  57.     Set  the  justification  of the textual output. These are the possible
  58.     justification types:
  59.  
  60.     IDJ_LEFT    - Left-justify text output.
  61.     IDJ_CENTER    - Center text output.
  62.     IDJ_RIGHT    - Right-justify text output.
  63.  
  64.     DEFAULT
  65.     IDJ_LEFT.
  66.  
  67.     APPLICABILITY
  68.     (ISGU).
  69.  
  70. indicatorclass/INDIC_Level
  71.  
  72.     NAME
  73.     INDIC_Level -- ( LONG )
  74.  
  75.     FUNCTION
  76.     Set or update the current level to indication.
  77.  
  78.     DEFAULT
  79.     0.
  80.  
  81.     APPLICABILITY
  82.     (ISGU).
  83.  
  84.     SEE ALSO
  85.     INDIC_Min, INDIC_Max, INDIC_FormatString
  86.  
  87. indicatorclass/INDIC_Max
  88.  
  89.     NAME
  90.     INDIC_Max -- ( LONG )
  91.  
  92.     FUNCTION
  93.     Set the maximum possible level indication.
  94.  
  95.     DEFAULT
  96.     100.
  97.  
  98.     APPLICABILITY
  99.     (ISGU).
  100.  
  101.     NOTE
  102.     Changing this attribute does not change the minimum width until a new
  103.     WM_OPEN and only redraws the object if the level is outside the new
  104.     bounds.
  105.  
  106.     SEE ALSO
  107.     INDIC_Min, INDIC_Level
  108.  
  109. indicatorclass/INDIC_Min
  110.  
  111.     NAME
  112.     INDIC_Min -- ( LONG )
  113.  
  114.     FUNCTION
  115.     Set the minimum possible level indication.
  116.  
  117.     DEFAULT
  118.     0.
  119.  
  120.     APPLICABILITY
  121.     (ISGU).
  122.  
  123.     NOTE
  124.     Changing this attribute does not change the minimum width until a new
  125.     WM_OPEN and only redraws the object if the level is outside the new
  126.     bounds.
  127.  
  128.     SEE ALSO
  129.     INDIC_Max, INDIC_Level
  130.  
  131.